Skip to content

fix(ItemStatsCalculator): pass itemId to error log - #477

Merged
AngeloTadeucci merged 1 commit into
masterfrom
fix-logging
Jun 8, 2025
Merged

fix(ItemStatsCalculator): pass itemId to error log#477
AngeloTadeucci merged 1 commit into
masterfrom
fix-logging

Conversation

@AngeloTadeucci

@AngeloTadeucci AngeloTadeucci commented Jun 8, 2025

Copy link
Copy Markdown
Collaborator

Summary by CodeRabbit

  • Bug Fixes
    • Improved error logging for item options to include more specific item identification details.

@coderabbitai

coderabbitai Bot commented Jun 8, 2025

Copy link
Copy Markdown
Contributor

Walkthrough

The changes update the ItemStatsCalculator class by adding an itemId parameter to the GetRandomOption and RandomItemOption methods and all their internal call sites. The itemId is now used in error logging within RandomItemOption, and method signatures are updated accordingly. No other logic is modified.

Changes

File(s) Change Summary
Maple2.Server.Game/Util/ItemStatsCalculator.cs Added itemId parameter to GetRandomOption and RandomItemOption methods and all call sites; updated logging to use itemId only.

Possibly related PRs

  • AngeloTadeucci/Maple2#475: Refactors the internal logic of RandomItemOption and improves validation; related as it also modifies the same methods.

Suggested reviewers

  • Zintixx

Poem

A hop and a skip, a parameter’s leap,
Now itemId journeys where options run deep.
In logs it now shines, with context anew,
Ensuring our errors are easy to view.
With every new hop, our code grows more bright—
A rabbit’s delight in the soft server light! 🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
Maple2.Server.Game/Util/ItemStatsCalculator.cs (1)

551-553: Use consistent placeholder name in error log
The log template uses {Item} for itemId; rename it to {ItemId} to improve clarity and consistency.

- Log.Logger.Error("Failed to select random item option, no more entries available. ItemId: {Item}", itemId);
+ Log.Logger.Error("Failed to select random item option, no more entries available. ItemId: {ItemId}", itemId);
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1c1eb48 and 20821ed.

📒 Files selected for processing (1)
  • Maple2.Server.Game/Util/ItemStatsCalculator.cs (6 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: build
🔇 Additional comments (6)
Maple2.Server.Game/Util/ItemStatsCalculator.cs (6)

116-116: Confirm itemId passed to GetRandomOption
Call site in GetStats correctly includes item.Id as the first argument to GetRandomOption.


161-161: Confirm itemId passed to GetRandomOption in UpdateRandomOption
UpdateRandomOption now delegates to GetRandomOption(item.Id, ...) with the new parameter.


395-395: Confirm itemId passed to RandomItemOption in GetStaticOption
The static path in GetStaticOption now invokes RandomItemOption(item.Id, ...) matching the updated signature.


416-418: Validate wrapper for RandomItemOption
The new GetRandomOption(int itemId, ...) wrapper correctly forwards to the static RandomItemOption method.


509-509: Verify updated signature of RandomItemOption
RandomItemOption now accepts int itemId as its first parameter, satisfying the PR objective to include itemId in error logs.


509-553:

Details

✅ Verification successful

Ensure all call sites are updated
Please verify that every invocation of GetRandomOption and RandomItemOption across the codebase uses the new signature.


🏁 Script executed:

#!/bin/bash
# Verify updated signatures for RandomItemOption and GetRandomOption
rg -nE "RandomItemOption\(|GetRandomOption\(" .

Length of output: 123


🏁 Script executed:

#!/bin/bash
# Correctly search for all invocations of RandomItemOption and GetRandomOption
rg -n -e 'RandomItemOption\(' -e 'GetRandomOption\(' .

Length of output: 1145


All calls to RandomItemOption and GetRandomOption have been updated and verified

I’ve searched the entire codebase and found only the following invocations in Maple2.Server.Game/Util/ItemStatsCalculator.cs, all matching the new signatures (using defaults where parameters are omitted):

  • Line 116: GetRandomOption(item.Id, itemOption, item.Type, ItemStats.Type.Random)
  • Line 161: GetRandomOption(item.Id, itemOption, item.Type, ItemStats.Type.Random, option.Count, presets)
  • Line 395: RandomItemOption(item.Id, itemOption, item.Type, statsType)
  • Lines 416–417: wrapper definition of GetRandomOption
  • Line 509: definition of RandomItemOption

No additional call sites exist.

@AngeloTadeucci
AngeloTadeucci merged commit 9600ba5 into master Jun 8, 2025
@AngeloTadeucci
AngeloTadeucci deleted the fix-logging branch June 8, 2025 18:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants